AMDocument object

You are here: COM API reference > Server objects > AMDocument object

AMDocument object

This object represents a document stored in the vault.

Members (AMDocument)
Name	Description
AccessRights property	Reserved. See About reserved objects, methods, and properties .
Archive property	Reserved. See About reserved objects, methods, and properties .
BeginNewRedlineVersion method	Reserved. See About reserved objects, methods, and properties .
BeginNewThumbnailVersion method	Reserved. See About reserved objects, methods, and properties .
CanDelete property	True if it is possible to delete the document.
CompressStream method	Reserved. See About reserved objects, methods, and properties .
ContentStorage property	Reserved. See About reserved objects, methods, and properties .
Copy method	Creates a copy of the document (will not cause events to occur).
Created property	The date/time the document was created.
CreatedBy property	The name of the person who created the document.
DeleteOutGoingDocRefWithID method	Removes the reference to another document (using the ID of the reference).
DisplayName property	The file name of the document.
DocumentType property	A reference to the document type object (AMDocumentType object).
DocumentTypeDisplayName property	The display name of the document type.
DocumentTypeName property	The internal name of the document type.
EndNewRedlineVersion method	Reserved. See About reserved objects, methods, and properties .
EndNewThumbnailVersion method	Reserved. See About reserved objects, methods, and properties .
FileType property	Windows-defined file type.
GetStream method	Reserved. See About reserved objects, methods, and properties .
ID property	Unique ID of the document object.
ImportedFrom property	Path the document was imported from.
IncomingDocRefs property	A collection of all references to this document.
IncomingDocuments property	A collection of all documents that reference this document.
IsFolder property	False.
IsStreamCompressed property	Reserved. See About reserved objects, methods, and properties .
LaunchedLogicExtensions property	Reserved. See About reserved objects, methods, and properties .
LoadProperties method	See About accessing object properties on how to query property values.
Modified property	The date the document content was last changed.
ModifiedBy property	The user who last edited the document.
Move method	Moves the document to another folder (does not cause any events to occur).
Name property	The internal name of the document.
NavigationPath property	The path where the document can be found in a Navigation view.
NewDocRef method	Creates a reference to another document.
OutgoingDocRefs property	A collection of all references to other documents.
OutgoingDocuments property	A collection of all documents referenced by this document.
ParentFolder property	Reference to the parent folder object (AMFolder object). See Remarks.
Path property	The path relative to the root of the vault.
RedlineAccessRights property	Reserved. See About reserved objects, methods, and properties .
RedlineSecurityData property	Reserved. See About reserved objects, methods, and properties .
RedlineStorage property	Reserved. See About reserved objects, methods, and properties .
Repository property	Reference to the current transaction (AMDocumentRepository object).
SaveProperties method	See About accessing object properties on how to edit property values.
SecurityData property	Reserved. See About reserved objects, methods, and properties .
Size property	The file size.
Status property	Description of the current workflow status of the document.
ThumbnailStorage property	Reserved. See About reserved objects, methods, and properties .
ThumbnailUpdated property	Date/time the thumbnail was last updated.
ViewerData property	Reserved. See About reserved objects, methods, and properties .

Members (IAMDocument2)
Name	Description
ChangeDocumentType method	Changes the document type of the document (does not cause any events to occur)
GetWritableStream method	Reserved. See About reserved objects, methods, and properties .
Replace method	Creates a new document and sets the document state to retired (does not cause any events to occur)
Derive method	Creates a new derived document (does not cause any events to occur)
CanEditContent property	True if the current user can edit the document content, taking privileges and state into account
CanViewContent property	True if the current user can view the document content, taking privileges and state into account
CanEditRedlines property	True if the current user can edit the document redlines, taking privileges and state into account
CanViewRedlines property	True if the current user can view the document redlines, taking privileges and state into account

Members (IAMDocument3)
Name	Description
Modified2 property	Reserved. See About reserved objects, methods, and properties .

Members (IAMDocument4)
Name	Description
RemoveDocumentHistory method	Reserved. See About reserved objects, methods, and properties .
GetReferencedDocuments method	Reserved. See About reserved objects, methods, and properties .

Members (IAMDocument5)
Name	Description
CopyEx method	Reserved. See About reserved objects, methods, and properties .
DeriveEx method	Reserved. See About reserved objects, methods, and properties .
ReplaceEx method	Reserved. See About reserved objects, methods, and properties .

Members (IAMDocument6)
Name	Description
LockID property	Reserved. See About reserved objects, methods, and properties .
GetDocumentInfo method	Reserved. See About reserved objects, methods, and properties .

Members (IAMDocument7)
Name	Description
GetDocReferences method	Reserved. See About reserved objects, methods, and properties .

Members (IAMDocument8)
Name	Description
HasRedlines property	True if the document contains redline information. Uses the value of the AMDocumentPropertySet._HAS_REDLINES property. See Remarks.
HasRedlineData property	True if any redline information is stored for the document. See Remarks.

Members (IAMDocument9)
Name	Description
GlobalID property	Global ID of the document
CreateGlobalID method	Generates new unique global ID

Members (IAMDocument10)
Name	Description
SetFullTextReindex method	Resets property _FTUPDATED

Other Interfaces

IAMHybridDocument interface

IAMRetentionControl object

IAMDocumentConfigurableWorkflow interface

IAMFSObject interface

IAMVersionable interface

IAMDocumentWorkflow interface

Remarks

The ParentFolder property should not be used from the BeforeWizard event. Use GetParentFolder method instead.

Any action invoked on the AMDocument object directly will not cause any client-side customization to occur. UIExtensions, VBScript events, and wizards will not be applied. If customization is required, use functionality provided by the AMEdmUI client-side library.

The server can be forced to update the HasRedline property by calling the HasRedlineData property as demonstrated in the following code sample.

Dim Doc as IAMDocument8
Set Doc = SelectedDocument
If Doc.HasRedlineData(True) Then
    ' Has Redline property has been updated by server
End If